home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2000 #4 / Amiga Plus CD - 2000 - No. 4.iso / Tools / Dev / Bgui / AutoDoc / cycleclass.doc < prev    next >
Encoding:
Text File  |  2000-05-09  |  2.2 KB  |  105 lines
  1. TABLE OF CONTENTS
  2.  
  3. cycleclass/--background--
  4. cycleclass/CYC_Active
  5. cycleclass/CYC_Labels
  6. cycleclass/CYC_PopActive
  7. cycleclass/CYC_Popup
  8.  
  9. cycleclass/--background--
  10.  
  11.     NAME
  12.     Class:        cycleclass
  13.     Superclass:    baseclass
  14.     Include File:    <libraries/bgui.h>
  15.  
  16.     FUNCTION
  17.     To  provide  a gadget simular to the gadtools.library it's cycle kind.
  18.     Objects from  this  class  will  send the following  attributes  pairs
  19.     in it's notification events:
  20.  
  21.     GA_ID        - Gadget object ID.
  22.     CYC_Active    - Gadget object active label number.
  23.  
  24. cycleclass/CYC_Active
  25.  
  26.     NAME
  27.     CYC_Active -- ( ULONG )
  28.  
  29.     FUNCTION
  30.     Set  or  get  the  number of the currently active label where 0 is the
  31.     first label in the array.
  32.  
  33.     DEFAULT
  34.     0.
  35.  
  36.     APPLICABILITY
  37.     (ISGNU).
  38.  
  39. cycleclass/CYC_Labels
  40.  
  41.     NAME
  42.     CYC_Labels -- ( STRPTR * )
  43.  
  44.     FUNCTION
  45.     Set an array of string pointers which will be the cycle gadget labels.
  46.     The  array  must  point to a valid NULL-terminated array or the object
  47.     will fail to create.
  48.  
  49.     DEFAULT
  50.     None.
  51.  
  52.     APPLICABILITY
  53.     (I).
  54.  
  55. cycleclass/CYC_PopActive
  56.  
  57.     NAME
  58.     CYC_PopActive -- ( BOOL ) ** V40 **
  59.  
  60.     FUNCTION
  61.     To make the menu of a cycle object  in    popup  mode  appear  with  the
  62.     currently  active  label  under  the mouse.   By default the menu will
  63.     appear just below the object.
  64.  
  65.     DEFAULT
  66.     FALSE.
  67.  
  68.     APPLICABILITY
  69.     (I).
  70.  
  71.     SEE ALSO
  72.     CYC_Popup
  73.  
  74. cycleclass/CYC_Popup
  75.  
  76.     NAME
  77.     CYC_Popup -- ( BOOL )
  78.  
  79.     FUNCTION
  80.     To make  the  cycle object into a popup menu. When this is set to TRUE
  81.     and you click in the object a menu appears  in    which  all choises are
  82.     visible. Selecting the wanted item is simular to normal menu-selection.
  83.     Pressing the right mouse-button will cancel the selection.
  84.  
  85.     Please note  that  when  the  popup  option is turned on and the cycle
  86.     object has  more  entries  than  can be made visible on the screen the
  87.     list will be truncated.
  88.  
  89.     On OS  3.0  systems  or  better  (V39++)  the menu will always use the
  90.     NewLook-menu coloring.    On  systems running less than OS 3.0 the menus
  91.     will appear in the BlockPen and DetailPen.
  92.  
  93.     You  can  recognize  a    cycle  object in popup mode by the small arrow
  94.     image pointing on a bar instead of the usual circular arrow image.
  95.  
  96.     DEFAULT
  97.     FALSE.
  98.  
  99.     APPLICABILITY
  100.     (I).
  101.  
  102.     SEE ALSO
  103.     CYC_PopActive
  104.  
  105.